﻿
namespace EasyNet.Solr.Commons.Params
{
    public struct TermVectorParams
    {
        public const string TV_PREFIX = "tv.";

        /// <summary>
        /// Return Term Frequency info
        /// </summary>
        public const string TF = TV_PREFIX + "tf";

        /// <summary>
        /// Return Term Vector position information
        /// </summary>
        public const string POSITIONS = TV_PREFIX + "positions";

        /// <summary>
        /// Return offset information, if available
        /// </summary>
        public const string OFFSETS = TV_PREFIX + "offsets";

        /// <summary>
        /// Return IDF information.  May be expensive
        /// </summary>
        public const string DF = TV_PREFIX + "df";

        /// <summary>
        /// Return TF-IDF calculation, i.e. (tf / idf).  May be expensive.
        /// </summary>
        public const string TF_IDF = TV_PREFIX + "tf_idf";

        /// <summary>
        /// Return all the options: TF, positions, offsets, idf
        /// </summary>
        public const string ALL = TV_PREFIX + "all";

        /// <summary>
        /// The fields to get term vectors for
        /// </summary>
        public const string FIELDS = TV_PREFIX + "fl";

        /// <summary>
        /// The Doc Ids (Lucene internal ids) of the docs to get the term vectors for
        /// </summary>
        public const string DOC_IDS = TV_PREFIX + "docIds";
    }
}
